Speed up npm installation and update oclif by EastSun5566 · Pull Request #121 · hackmdio/hackmd-cli

EastSun5566 · 2026-10-28T18:13:05Z

Closes #120

Speeds up global npm installation by moving build tools to development dependencies and upgrading oclif. Preserves existing table options, hidden token input, and fish completion.

Validation: build, lint, unit and smoke tests, plus isolated npm installs with and without --ignore-scripts.

Copilot

🟡 Changes recommended

Unresolved issues break property-key column options, alter null filtering behavior, and prevent package validation on Windows.

3 open issues

What changed in this PR

This PR reduces the CLI’s runtime dependency footprint and upgrades oclif to address slow global npm installation in #120.

Changes:

Moves oclif build tooling to development dependencies and removes legacy dependencies.
Adds replacement table rendering, hidden token prompting, and fish completion support.
Adds compatibility tests and isolated package-install validation, and refreshes documentation.

File	Description
`tsconfig.json`	Targets ES2022 output.
`test/table.test.ts`	Tests table formatting, filtering, sorting, and flags.
`test/prompt-cancel.test.ts`	Tests cancellation exit status.
`test/helpers/init.js`	Removes legacy oclif test initialization.
`test/autocomplete.test.ts`	Tests fish completion generation and quoting.
`src/table.ts`	Adds shared table rendering and flags.
`src/commands/whoami.ts`	Uses the shared table helper.
`src/commands/teams.ts`	Uses the shared table helper.
`src/commands/team-notes/index.ts`	Migrates team-note listing to shared tables.
`src/commands/team-notes/create.ts`	Migrates team-note creation output.
`src/commands/team-folders/index.ts`	Migrates team-folder listing output.
`src/commands/team-folders/create.ts`	Migrates team-folder creation output.
`src/commands/notes/index.ts`	Migrates note listing output.
`src/commands/notes/create.ts`	Migrates note creation output.
`src/commands/history.ts`	Migrates browsing-history output.
`src/commands/folders/index.ts`	Migrates folder listing output.
`src/commands/folders/create.ts`	Migrates folder creation output.
`src/commands/autocomplete/script.ts`	Adds fish script sourcing and plugin delegation.
`src/commands/autocomplete/index.ts`	Adds completion setup and cache refresh handling.
`src/command.ts`	Replaces token prompting and handles cancellation.
`src/autocomplete.ts`	Generates fish completions and delegates other shells.
`scripts/test-package.mjs`	Validates isolated installs and packaged CLI behavior.
`README.md`	Documents completion setup and refreshes command help.
`package.json`	Updates dependencies and build/test scripts.
`bin/run`	Uses the current oclif execution entry point.
`bin/dev`	Updates development-mode execution.
`.mocharc.json`	Disables native type stripping for tests.
`.github/workflows/test.yml`	Adds shell tooling and package-install validation.

_{Review effort: Balanced}

Copilot

🔵 Needs a closer look

The column resolver matches only display headers, so table flags using property names can drop columns, throw filter errors, or silently ignore sorting.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Add root help and version flags to Fish completion

src/autocomplete.ts:32

Register the root help and version flags in the generated Fish completion. Every flag entry generated below requires a command path, so hackmd-cli --<TAB> cannot suggest --help or --version, and their short forms are missing too. These are supported entry points configured in package.json and checked by the smoke tests; add root-scoped completion entries for them.

3 resolved since last review

_{Review effort: Balanced}

Yukaii

Thanks for the install footprint work — moving oclif to devDependencies and replacing cli-ux with a local table helper is the right direction for #120, and CI looks green.

Two regressions in src/table.ts vs the old oclif/cli-ux table options; happy to approve once these are fixed:

Column lookup by key — findColumn only matches display headers, so flags that use property names (teamPath, userPath, ownerId, parentFolderId, …) no longer work (--columns, --filter, --sort).
null vs empty string — ?? '' collapses real null fields to "", so filters like Team Path=^null$ stop matching. Prefer defaulting only undefined so null still stringifies as 'null'.

Nits (non-blocking): fish root --help / --version completion, and engines.node is now >=24.

Copilot

🔵 Needs a closer look

Column lookup breaks selection, sorting, and filtering by property keys; explicit null values become empty strings; and narrow-terminal output can still wrap despite truncation being enabled.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Clip output when minimum column widths exceed terminal width

src/table.ts:108

The sizing loop stops at the header-based minimum widths even when the table still exceeds the terminal width, so default output wraps despite truncation being enabled. For example, the six folder columns require 48 characters before separators, but a 40-column terminal leaves available at 33. Add a fallback that truncates headers or clips rendered lines safely when those minimum widths cannot fit, while preserving --no-truncate.

_{Review effort: Balanced}

EastSun5566 added 4 commits October 29, 2026 01:18

fix: remove build-only dependencies from runtime

a1127c8

refactor: decouple table output from oclif

7e3ad19

refactor: upgrade oclif and preserve CLI behavior

744920c

test: verify packed CLI installations

3975dc5

EastSun5566 marked this pull request as ready for review October 28, 2026 18:32

Copilot AI balanced review requested due to automatic review settings October 28, 2026 18:32

Copilot started reviewing on behalf of EastSun5566 October 28, 2026 18:33

View session

Copilot AI reviewed Oct 28, 2026

View reviewed changes

Comment thread scripts/test-package.mjs Resolved

Comment thread src/table.ts Resolved

Comment thread src/table.ts Resolved

fix: launch npm with Node in package tests

0df738c

Copilot AI balanced review requested due to automatic review settings October 28, 2026 19:16

Copilot started reviewing on behalf of EastSun5566 October 28, 2026 19:18

View session

Copilot AI reviewed Oct 28, 2026

View reviewed changes

EastSun5566 requested a review from Yukaii October 30, 2026 04:50

Yukaii reviewed Nov 4, 2026

View reviewed changes

Comment thread src/table.ts Resolved

Comment thread src/table.ts Resolved

fix: complete root flags in fish

55a5f46

Copilot AI balanced review requested due to automatic review settings November 4, 2026 05:14

Copilot started reviewing on behalf of EastSun5566 November 4, 2026 05:14

View session

EastSun5566 requested a review from Yukaii November 4, 2026 05:16

Copilot AI reviewed Nov 4, 2026

View reviewed changes

Yukaii approved these changes Nov 4, 2026

View reviewed changes

Yukaii merged commit cd31d5f into develop Nov 4, 2026
5 checks passed

Yukaii deleted the feat/120-faster-install branch November 4, 2026 05:33

Navigation Menu

Repository navigation

Speed up npm installation and update oclif - #121

Speed up npm installation and update oclif#121
Yukaii merged 6 commits into
developfrom
feat/120-faster-install

EastSun5566 commented Oct 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Yukaii left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

EastSun5566 commented Oct 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

Yukaii left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants